home *** CD-ROM | disk | FTP | other *** search
/ Resource for Source: C/C++ / Resource for Source - C-C++.iso / misc_src / lltest / lltest.txt < prev   
Text File  |  1995-11-01  |  8KB  |  261 lines
  1.  
  2. LINKED LIST TEST WORKBENCH
  3.  
  4. (C) Copyright 1994
  5.  
  6. Think Tank Enterprises (TM)
  7.  
  8. Dr. Eric Horowitz
  9.  
  10. CONTENTS OF THIS FILE:
  11.  
  12. 1.  Overview
  13. 2.  Instalation
  14. 3.  Operation
  15. 4.  Function Description
  16. 5.  More available
  17. 6.  Licensing
  18. 7.  Disclaimer
  19.  
  20. -----------------------------------------------------------------------
  21.  
  22. 1. Overview
  23.  
  24. Linked lists are fundemental building blocks of data management within
  25. any programming environment.  They provide a simple means of creating 
  26. stacks, queues and arrays that can grow and shrink dynamically.  Linked
  27. lists can be used to organize numbers, text strings, structures or anything
  28. that can be pointed to. In fact, you can even have a list of lists!
  29.  
  30. TTE's linked list class provides a C++ class from which linked lists can
  31. easily be constructed and manipulated.
  32.  
  33. This distribution contains the Linked List Test Workbench which is a 
  34. user-freindly demonstration program illustrating the functionality of 
  35. TTE's linked list class. 
  36.  
  37. With the Workbench, you can exercise all of the functionality of TTE's
  38. linked list class, by manipulating lists of text strings. Remember - even
  39. though this Test Workbench only creates lists of text strings, you can
  40. create lists of any object type with the TTE linked list class.
  41.  
  42. -----------------------------------------------------------------------
  43.  
  44. 2. Instalation
  45.  
  46. Installation of this package is simple and is applicable to any WINDOWS
  47. program.  
  48.      
  49.       A) in the Program Manager, 
  50.       
  51.         1) select a program group where the workbench will reside
  52.          (Example, click on the "Main" program group)
  53.  
  54.         2) select the "File" menu option
  55.         3) select the "New..." submenu option
  56.  
  57.       B) In the "New Program Object" Dialog
  58.  
  59.         1) select "Program Item" (usually the default)
  60.         2) select the "OK" button
  61.  
  62.       C) In the "Program Item Properties" Dialog
  63.  
  64.         1) Type "Linked List Workbench" in the "Description" field
  65.         2) Select the "Browse" button
  66.  
  67.       D) In the "Browser" Dialog
  68.  
  69.         1) Select "lltest.exe" in the directory containing this software
  70.         2) Select the "OK" button
  71.  
  72.       E) In the "Program Item Properties" Dialog (again)  
  73.  
  74.          1) select the "OK" button
  75.  
  76.       This should place the Linked List Test Workbench icon in the
  77.       group you selected. 
  78.  
  79.       Simply double-click on the icon like you would any other
  80.       Windows application.
  81.  
  82. -----------------------------------------------------------------------
  83.  
  84. 3. Operation
  85.  
  86. The Workbench is simple to operate.  Simply click on a button to see
  87. how it works.  Workbench buttons invoke functions of the LinkList class 
  88. and provide input and output to the user.  The following describes the
  89. Workbench functions.
  90.  
  91. 3.1 INPUT:
  92.  
  93. Functions requiring textual input read from the "Input Element" box.
  94. The value must be supplied BEFORE selecting the function. These functions
  95. simply read the current value (even NULL).
  96.  
  97. Functions requiring numerical input will create their own input dialog for
  98. you to use. 
  99.  
  100. 3.2 OUTPUT:
  101.  
  102. Functions that return elements display the value in the "Retrieved Element"
  103. box. 
  104.  
  105. The NUMBER function returns the number of elements in the list and creates
  106. its own dialog box to display it.
  107.  
  108. Any function that modifies the list rewrites the list in the "Forwards" and
  109. "Backwards" boxes. This is done to demonstrate that the lists remain
  110. correctly linked after being modified.
  111.  
  112. -----------------------------------------------------------------------
  113.  
  114. 4. Function Description
  115.  
  116. This section describes the functionality of each of the LinkList class 
  117. functions. This class maintains a reference to the current element of the 
  118. list. The current element is the one previously referenced (or prior to
  119. the one previously deleted). "Next" refers to the element after the current
  120. element and "previous" refers to the element before the current element.
  121.  
  122. "Ith" refers to an operation affecting element "i" of the list. "i" is a
  123. numerical value supplied by the user. Note that the first element has an
  124. index value of 0. In the Workbench, all Ith functions prompt the user for 
  125. a value of "i".
  126.  
  127. 4.1 GET   Functions
  128. 4.2 POP   Functions
  129. 4.3 Reset Functions
  130. 4.4 ADD   Functions
  131. 4.5 Other Functions
  132.  
  133. 4.1 GET Functions 
  134.  
  135.    Get functions retrieve elements off of the list but DO NOT remove the
  136.    elements.
  137.  
  138.    Get1st   -  Retrieves the first element of the list.
  139.  
  140.    GetLast  -  Retrieves the last element of the list.
  141.  
  142.    GetIth   -  Retrieves the Ith element of the list.
  143.  
  144.    GetNext  -  Retrieves the next element of the list.
  145.  
  146.    GetPrev  -  Retrieves the previous element of the list.
  147.  
  148.    GetCurr  -  Retrieves the current element of the list.
  149.  
  150. 4.2 POP Funtions
  151.  
  152.    Pop functions retreive elements off of the list AND remove the elements
  153.    from the list thereby making the list shorter.
  154.  
  155.    Pop1st   -  Pops the first element of the list.
  156.  
  157.    PopLast  -  Pops the last element of the list.
  158.  
  159.    PopIth   -  Pops the Ith element of the list.
  160.  
  161.    PopNext  -  Pops the next element of the list.
  162.  
  163.    PopPrev  -  Pops the previous element of the list.
  164.  
  165.    PopCurr  -  Pops the current element of the list.
  166.  
  167. 4.3 Reset Functions
  168.  
  169.    Reset functions (abbreviated Rst) change the values in the list with 
  170.    new values. In the process, they return the OLD value.
  171.  
  172.    Rst1st   -  Resets the first element of the list.
  173.  
  174.    RstLast  -  Resets the last element of the list.
  175.  
  176.    RstIth   -  Resets the Ith element of the list.
  177.  
  178.    RstNext  -  Resets the next element of the list.
  179.  
  180.    RstPrev  -  Resets the previous element of the list.
  181.  
  182.    RstCurr  -  Resest the current element of the list.
  183.  
  184. 4.4 Add Functions
  185.  
  186.    Add functions add new elements to the list, thereby making the list
  187.    longer.  Purists will call these PUSH functions. Here we avoid the
  188.    term because PURE purists will note that you only PUSH to the end of
  189.    a list and not somewhere in the middle. (ABSOLUTELY pure purists may 
  190.    complain that the same applies to POP as well!).
  191.  
  192.    Add1st   -  Adds an element to the beginning of the list.
  193.  
  194.    AddLast  -  Adds an element to the end of the list.
  195.  
  196.    AddIth   -  Adds an element as the Ith element of the list.
  197.  
  198.    AddNext  -  Adds an element after the current element of the list.
  199.  
  200.    AddPrev  -  Adds an element prior to the current element of the list.
  201.  
  202.    Note that there is no AddCurr function. If it would mean make the new
  203.    element the current element and thus the current element the next 
  204.    element, this is the same as AddPrev. If it would mean to add an 
  205.    element after the current element, this would be the same as AddNext.
  206.  
  207. 4.5 Other Functions
  208.  
  209.    Number    -  Reports on the number of elements in the list.
  210.  
  211.    ClearList -  Removes all elements from the list. 
  212.  
  213.    Info      -  Displays version information regarding the Workbench.
  214.  
  215.    Quit      -  Terminates the Workbench
  216.  
  217. -----------------------------------------------------------------------
  218.  
  219. 5.  More available
  220.  
  221.   This Workbench simply demonstrates the capabilities of the Linked List
  222.   class.  To actually USE this class in your code, you can purchase the
  223.   Liked List development kit by sending $35 to 
  224.  
  225.   Think Tank Enterprises
  226.   4518 Dresden Rd.
  227.   Baltimore, MD  21208  
  228.   
  229.   The kit includes:
  230.  
  231.   * Object code for the LinkedList class.
  232.   * Header file for the LinkedList class.
  233.   * Source code for the Workbench 
  234.       (including header files and resource files - 
  235.        this is worth $35 by itself!!!).
  236.   * Instructions
  237.  
  238.   The source code for the LinkedList class is NOT included.
  239.  
  240.   The kit comes on a 3-1/2" DD diskette
  241.  
  242. -----------------------------------------------------------------------
  243.  
  244. 6.  Licensing
  245.  
  246. All rights are reserved. This workbench is FREE. It may be distributed
  247. under the following conditions:
  248.  
  249.    1. No modifications are made to any of the distribution files.
  250.    2. All of the distribution files are distributed together.
  251.  
  252. -----------------------------------------------------------------------
  253.  
  254. 7.  Disclaimer
  255.  
  256. This package is supplied AS IS. TTE makes no warrenty explicit or implied 
  257. as to the suitability of this product for any purpose. TTE assumes no 
  258. liablility for any consequences due to the use of this package.  
  259.  
  260.  
  261.